/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package org.neo4j.io.pagecache.prefetch;

import java.nio.file.Path;
import org.neo4j.kernel.lifecycle.Lifecycle;

/**
 * Component that can load pages into page cache in background
 */
public interface PagePrefetcher extends Lifecycle {

    PagePrefetcher DISABLED = new PagePrefetcher() {
        @Override
        public void init() {}

        @Override
        public void start() {}

        @Override
        public void stop() {}

        @Override
        public void shutdown() {}

        @Override
        public void submit(Path path, long[] pages) {}
    };

    /**
     * Ask prefetcher to load file pages for specific file. Sorted array is prefered.
     * @param path file path
     * @param pages page numbers
     */
    void submit(Path path, long[] pages);
}
